Content Library Item Updatesession File Info

Content Library Item Updatesession File Info
Content Library Item Updatesession File Info

The Content Library Item Updatesession File Info schema defines the uploaded file.

JSON Example
{
    "name": "string",
    "source_type": "string",
    "size": 0,
    "checksum_info": {
        "algorithm": "string",
        "checksum": "string"
    },
    "source_endpoint": {
        "uri": "string",
        "ssl_certificate_thumbprint": "string",
        "ssl_certificate": "string"
    },
    "upload_endpoint": {
        "uri": "string",
        "ssl_certificate_thumbprint": "string",
        "ssl_certificate": "string"
    },
    "bytes_transferred": 0,
    "status": "string",
    "error_message": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "keep_in_storage": false
}
string
name
Required

The name of the file.

string
source_type
Required

The source type (SourceType) from which the file is being retrieved. This may be Content Library Item Updatesession File SourceType.NONE if the file is not being changed.

For more information see: Content Library Item Updatesession File SourceType.

integer As int64 As int64
size
Optional

The file size, in bytes as received by the server. This property is guaranteed to be set when the server has completely received the file.

This property won't be set until the file status is Content Library Item TransferStatus.READY.

checksum_info
Optional

The checksum information of the file received by the server.

If missing or null, the server does not verify the checksum.

source_endpoint
Optional

A source endpoint from which to retrieve the file.

This property is optional and it is only relevant when the value of source_type is Content Library Item Updatesession File SourceType.PULL.

upload_endpoint
Optional

An upload endpoint to which the client can push the content.

This property is optional and it is only relevant when the value of source_type is Content Library Item Updatesession File SourceType.PUSH.

integer As int64 As int64
bytes_transferred
Required

The number of bytes of this file that have been received by the server.

string
status
Required

The transfer status (TransferStatus) of this file.

For more information see: Content Library Item TransferStatus.

error_message
Optional

Details about the transfer error.

An error message is set if the status is Content Library Item TransferStatus.ERROR.

boolean
keep_in_storage
Optional

Whether or not the file will be kept in storage upon update session completion. The flag is true for most files, and false for metadata files such as manifest and certificate file of update session with library item type OVF. Any file with Content Library Item Updatesession File Info.keep_in_storage set to false will not show up in the list of files returned from GET /content/library/item/{libraryItemId}/file upon update session completion.

This property was added in vSphere API 6.8.

If missing or null, the file will be kept in storage upon update session completion.

Returned By